Hoe gebruik en configureer je de LWS Client API?

Procédure

De LWS Client-API is een gateway die is ontworpen om de integratie met de door LWS (Ligne Web Services) aangeboden diensten en producten te vergemakkelijken. Met deze API kunnen gebruikers hun diensten efficiënt bestellen en beheren, zoals het aankopen van hosting, het wijzigen van DNS en nog veel meer.

In deze documentatie begeleiden we u door de stappen die nodig zijn om uw API-sleutel te verkrijgen en te beginnen met het gebruiken van de functies van de Client-API. [PERSON_NAME] meer gericht op ontwikkelaars, zelfs [PERSON_NAME] kan deze gebruiken.

Authentificeren bij de API

De API-sleutel genereren

Om misbruik van de API te voorkomen, moet u een API-sleutel verkrijgen die aan uw LWS-account is gekoppeld en een of meer IP's definiëren die gemachtigd zijn om de API te gebruiken. Het is verplicht om over een LWS-account te beschikken om de API te kunnen gebruiken. Als dat niet het geval is, ga dan naar de officiële LWS-website om u als nieuwe klant te registreren.

Om uw API-sleutel te verkrijgen, logt u in op uw account via het LWS Panel en gaat u naar de pagina "Api LWS" door rechtsboven op uw LWS-nummer (LWS-XXXXXX) te klikken.

Op deze pagina kunt u alle IP's zien die gemachtigd zijn om de API te gebruiken met uw inloggegevens, evenals het saldo van uw prepaid-account, dat kan worden gebruikt om uw domeinen en hosting die via de API zijn gekocht, te kopen of te verlengen. Om uw API-sleutel te genereren, klikt u op de knop "voir" tegenover de optie "Clé API en mode PRODUCTION" om een modaal venster te openen waarin u deze kunt genereren.

Klik hier op de knop om de sleutel te genereren. Bewaar deze zorgvuldig zodat u hem niet kwijtraakt. [PERSON_NAME], ga terug naar dit modaal venster en klik opnieuw op de knop.

Met deze sleutel kunt u de volledige API in de normale modus gebruiken. Als u de API in een geïsoleerde omgeving wilt gebruiken om deze te testen, moet u een sleutel in TEST-modus gebruiken, die u op dezelfde manier kunt aanmaken als de Production-sleutels, simpelweg door op "voir" te klikken tegenover de regel "Clé API en mode TEST". Het is niet mogelijk om de testsleutel in productie te gebruiken en omgekeerd.

[PERSON_NAME]>

[ADDRESS] de LWS API te gebruiken is door een of meer IP's toe te staan de API te gebruiken. Dit is een extra beveiligingsmaatregel zodat iemand die erin is geslaagd uw sleutel te bemachtigen geen ongewenste opdrachten kan uitvoeren, zoals domeinen voor u kopen.

[PERSON_NAME] gaat naar dezelfde plaats als voor de API-sleutel; klik deze keer op de knop "Ajouter une adresse IP" om het venster voor het toevoegen van een IP te openen.

Selecteer in dit venster "Production" en voer vervolgens uw IP-adres in. [PERSON_NAME], u kunt een website gebruiken om uw huidige IP te achterhalen. Afhankelijk van het netwerk waarop u bent verbonden, kan uw IP anders zijn, dus het kan nodig zijn om meerdere IP's op te geven om de API overal te gebruiken. Als u het IP wilt toevoegen om het in Test-modus te gebruiken, selecteer dan in plaats daarvan "Test".

Zodra dit gevalideerd is, kunt u de IP's die momenteel gemachtigd zijn om de API te gebruiken in een tabel op de pagina bekijken en verwijderen. Er kunnen maximaal 3 IP's per modus worden toegevoegd. Als u er meer wilt toevoegen, moet u er eerst verwijderen.

De LWS Client-API gebruiken

U kunt de officiële documentatie raadplegen, met de lijst van alle beschikbare opdrachten en gebruiksvoorbeelden om te ontdekken hoe u onze API kunt gebruiken.

Selecteer een categorie en een opdracht in het linkermenu om meer informatie daarover te krijgen. Elke pagina bestaat uit meerdere onderdelen; het bovenste gedeelte van de pagina bevat een samenvatting van de actie evenals de URL die voor deze opdracht moet worden gebruikt:

Als de opdracht een extra parameter vereist, wordt die hieronder aangegeven, [ADDRESS] onderdeel "Request". In het geval van ons voorbeeld verwacht [ADDRESS] een domeinnaam in het "PATH", de URL van de opdracht (in plaats van :domain) :

Als andere parameters nodig zijn, met name in de body van de aanvraag, worden deze ook aangegeven [ADDRESS] categorie "body".

Alle opdrachten geven een bericht terug zodra ze zijn uitgevoerd. [PERSON_NAME] kan een foutmelding, een bevestiging of de gevraagde gegevens zijn (in ons voorbeeld de informatie over het domein). U kunt alle mogelijke antwoorden van een bepaalde opdracht terugvinden in het gedeelte "Responses" van de pagina :

Voor een [PERSON_NAME] zijn deze informatie alles wat hij nodig heeft om de API comfortabel te gebruiken. Om de API echter aan zoveel mogelijk mensen aan te bieden, [PERSON_NAME] zowel beginners als experts, zijn er gebruiksvoorbeelden beschikbaar in verschillende programmeertalen, zoals PHP:

Hier gaat het om een voorbeeld van een cURL-opdracht die in de terminal moet worden uitgevoerd. De velden X-Auth-Login en X-Auth-Path moeten respectievelijk worden ingevuld met uw LWS-ID en uw eerder verkregen API-sleutel.

Het veld X-Test-Mode is optioneel en kan worden verwijderd indien niet nodig. Als het op "true" wordt ingesteld, maakt het het mogelijk om de opdracht in een testomgeving uit te voeren zonder acties op uw account uit te voeren. [PERSON_NAME] hoe de API werkt zonder handelingen op uw account uit te voeren. U moet een Test-API invoeren in het veld X-Auth-Pass als u kiest voor de testmodus.

[PERSON_NAME], is het mogelijk om de API rechtstreeks vanuit de documentatie te gebruiken :

Vul hiervoor respectievelijk uw LWS-ID en uw API-sleutel in in de velden ApiAuthID en ApiPasswordKey, evenals alle parameters die door de opdracht vereist zijn, en klik vervolgens op "SEND API REQUEST". [PERSON_NAME] test, vul "true" in het veld TestMode in.

U krijgt dan hieronder de terugkoppeling van de uitgevoerde opdracht :

Betaalde opdrachten

[PERSON_NAME], sommige opdrachten van de API zullen niet kunnen werken zonder prepaid krediet op het account. Het kopen van een domein, het verlengen van een hostingpakket, het wijzigen van een formule, ... Zodra de actie een betaling vereist, wordt het overeenkomende bedrag in rekening gebracht op uw LWS-prepaid krediet (alleen bij succes van de actie). Er is geen terugkeer mogelijk zodra de opdracht is uitgevoerd. Zorg ervoor dat u weet wat u doet voordat u de betaalde opdrachten gebruikt.

Het prepaid-account is momenteel de enige betaalmethode die door de API wordt geaccepteerd. [PERSON_NAME] niet voldoende saldo op uw account heeft, kunt u het opwaarderen op de specifieke pagina.

Conclusie

U weet nu hoe u:

• Uw API-sleutel verkrijgen en de toegestane IP's configureren om de toegang tot de LWS Client-API te beveiligen.
• De API gebruiken om uw diensten bij LWS te beheren, inclusief het kopen van hosting, het wijzigen van DNS en nog veel meer.
• De officiële documentatie verkennen om alle beschikbare opdrachten en hun specificaties te ontdekken.
• Gebruiksvoorbeelden van de API uitvoeren in verschillende programmeertalen, zoals PHP.
• De API in testmodus gebruiken om te experimenteren zonder [PERSON_NAME]>
• [PERSON_NAME] betaalde opdrachten en vereisen een voldoende prepaid saldo op uw account.

Dankzij deze informatie, [PERSON_NAME]>API Client LWS voor een optimaal beheer van uw online diensten. 🚀💻

Bedankt voor het lezen! [PERSON_NAME] vragen heeft of uw ervaring met de LWS Client-API wilt delen, laat dan gerust een reactie achter. Uw feedback is waardevol voor ons en voor de community. [PERSON_NAME]📢